Skip to content

GH-1949: Document that overriding discovery locator filters replaces defaults#4199

Merged
ryanjbaxter merged 1 commit into
spring-cloud:mainfrom
won-seoop:doc-1949-discovery-locator-filter-override
Jun 15, 2026
Merged

GH-1949: Document that overriding discovery locator filters replaces defaults#4199
ryanjbaxter merged 1 commit into
spring-cloud:mainfrom
won-seoop:doc-1949-discovery-locator-filter-override

Conversation

@won-seoop

Copy link
Copy Markdown
Contributor

Summary

Closes #1949

The existing documentation mentioned that users must re-include the default RewritePath filter when customizing spring.cloud.gateway.discovery.locator.filters, but the warning was easy to miss.

This PR adds an explicit [IMPORTANT] callout block that:

  • Explains that filters configuration replaces the entire default filter list (not appends to it)
  • Describes the concrete failure mode: requests result in 404 on the downstream service because the service ID is not stripped from the path
  • Points the reader to the examples that show the correct pattern (include RewritePath)

Test plan

  • AsciiDoc renders with the IMPORTANT callout visible
  • Example YAML/properties still shows RewritePath included alongside the custom CircuitBreaker filter

🤖 Generated with Claude Code

…rs replaces all defaults

Add an IMPORTANT callout to make it clear that setting
spring.cloud.gateway.discovery.locator.filters replaces the entire
default filter list, meaning the RewritePath filter must be explicitly
re-declared or downstream services will receive the unstripped path and
return 404.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ryanjbaxter ryanjbaxter merged commit 39aa9a4 into spring-cloud:main Jun 15, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document overriding filter definitions when s.c.g.discovery.locator.enabled=true.

3 participants